Skip to main content

CreateStack

Description​

call CreateStack interface to create resource stack.

Request Method​

POST

Request Path​

/apsara/route/ROS/CreateStack

Request Parameters Common Parameters​

NameLocationTypeRequiredSample valueDescription
Parameters.N.ParameterKeyBODYstringYesInstanceIdparameter name. If the name and value of the parameter are not specified, ROS will use the default value specified in the template. The maximum value of N is: 200. description Parameters as an optional parameter. if the Parameters needs to be specified, the Parameters. n. ParameterKey and Parameters. n. ParameterValue must be specified at the same time.
Parameters.N.ParameterValueBODYstringYesi-xxxxxxparameter value. The maximum value of N is: 200. description Parameters as an optional parameter. if the Parameters needs to be specified, the Parameters. n. ParameterKey and Parameters. n. ParameterValue must be specified at the same time.
TemplateBodyBODYstringNo{ "ROSTemplateFormatVersion": "2015-09-01" }the structure of the template body. The length is 1~524 and 288 bytes. If the length is large, it is recommended to pass the parameters in the request body through HTTP POST + Body Param to avoid request failure due to too long URL. description you must specify the parameter TemplateBody or TemplateURL, but not at the same time.
StackPolicyBodyBODYstringNo{"Statement": [{"Action": "Update:*", "Resource": "*", "Effect": "Allow", "Principal": "*"}]}contains the structure of the resource stack policy body, with a length of 1~16,384 bytes. description you must specify StackPolicyBody or StackPolicyURL parameters, but not at the same time.
NotificationURLs.NBODYrepeatlistNohttp://my-site.com/ros-eventURL callback address for receiving stack events. Currently, only HTTP POST is supported. N maximum value: 5. maximum length of each URL: 1024 bytes. when the status of the resource stack changes, it will be notified. When the resource stack enables rollback, CREATE_FAILED (creation failure) and UPDATE_FAILED (update failure) are not notified, while CREATE_ROLLBACK (creation failure rollback) and ROLLBACK (update failure rollback) are notified. Description IN_PROGRESS status will not be notified. notifications will be made regardless of whether the Outputs is defined in the resource stack. An example of notification content is as follows: { "Outputs ": [ { "Description": "No description given ", "OutputKey": "InstanceId ", "OutputValue": "i-xxx" } ], "StackId": "80bd6b6c-e888-4573-ae3b-93d29113 ****", "StackName": "test-notification-url ", "Status": "CREATE_COMPLETE"}
DeletionProtectionBODYstringNoEnabledwhether to enable stack deletion protection. Value: Enabled: enable stack deletion protection. Disabled (default): turn off stack deletion protection. At this time, the resource stack can be released through the console or API(DeleteStack). description nested resource stack deletion protection is consistent with the root resource stack.
StackPolicyURLBODYstringNooss://ros-stack-policy/demothe location of the file containing the resource stack policy. The URL must point to a policy located in a Web server (HTTP or HTTPS) or Aliyun OSS bucket (for example, oss:// ros/stack-policy/demo, oss:// ros/stack-policy/demo?RegionId = cn-hangzhou). The maximum length of the policy file is 16 and 384 bytes. If the OSS region is not specified, the default RegionId is the same as the interface parameter. description you must specify the parameter StackPolicyBody or StackPolicyURL, but not at the same time. The maximum length of the URL is 1350 bytes.
versionBODYstringNo2016-01-01version of api
TemplateURLBODYstringNooss://ros-template/demothe location of the file containing the template body. The URL must point to the template (1~524,288 bytes) located in the HTTP Web server (HTTP or HTTPS) or Aliyun OSS bucket. The URL of the OSS bucket is such as oss:// ros/template/demo or oss:// ros/template/demo?RegionId = cn-hangzhou. If the OSS region is not specified, the default RegionId is the same as the interface parameter. description you must specify TemplateBody or TemplateURL parameters, but not at the same time.
RamRoleNameBODYstringNotest-roleRAM role name. ROS will play this role to create a resource stack and use the role's credentials to make interface calls on behalf of the user. ROS always uses this role for operations that will take place on the resource stack. As long as the user has the right to operate on the resource stack, even if the user does not have the right to use the role, ROS will use this role to ensure that the role grants minimal permissions. If the user does not specify this value, ROS will use the role previously associated with the resource stack. If no role is available, ROS will use temporary credentials generated from your user credentials. the maximum length of the RAM role name is 64 characters.
regionIdBODYstringYesNo sample value for this parameter.region id
RegionIdBODYstringYescn-hangzhouthe region ID to which the resource stack belongs.
CreateOptionBODYstringNoKeepStackOnCreationCompleteused to control the behavior of creating resource stacks, value: KeepStackOnCreationComplete (default): after the resource stack is successfully created, the resources in the resource stack and the resource stack are retained, occupying the limit of the number of resource stacks allowed by ROS. AbandonStackOnCreationComplete: delete the resource stack after the resource stack is successfully created, but retain all resources and do not occupy the limit of the number of resource stacks allowed by ROS. If the resource stack creation fails, the resource stack will be retained.
ClientTokenBODYstringNo123e4567-e89b-12d3-a456-42665544****guarantees the idempotence of the request. This value is generated by the client and must be globally unique. is no more than 64 characters in length and can contain English letters, numbers, dashes (-) and underscores (_).
StackNameBODYstringYesMyStackresource stack name. must be no more than 255 characters in length and must start with a number or an English letter, which can contain numbers, English letters, dashes (-), and underscores (_).
DisableRollbackBODYbooleanNofalsewhether to disable the rollback policy when the resource stack creation fails. Value: true: disable rollback, that is, no rollback is performed when the resource stack creation fails. false (default): rollback is not disabled, that is, rollback is performed when the resource stack creation fails.
TimeoutInMinutesBODYlongNo10timeout for creating the resource stack. default value: 60. Unit: minutes.

Return data​

NameTypeSample valueDescription
RequestIDstring1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DCRequest id

Example​

Successful Response example​

{
 "RequestID":"1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC"
}

Failed Response example​

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}